/**
 * Copyright (C) 2002-2015   The FreeCol Team
 * <p>
 * This file is part of FreeCol.
 * <p>
 * FreeCol is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * <p>
 * FreeCol is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.server.generator;

import net.sf.freecol.common.model.Map;
import net.sf.freecol.common.util.LogBuilder;


/**
 * Creates maps and sets the starting locations for the players.
 */
public interface MapGenerator
{

    /**
     * Create an empty map.
     *
     * @param width The map width.
     * @param height The map height.
     * @return A new empty <code>Map</code>.
     */
    public abstract Map createEmptyMap( int width, int height, LogBuilder lb );

    /**
     * Creates the map with the current set options
     *
     * @return The new <code>Map</code>.
     */
    public abstract Map createMap( LogBuilder lb );
}
